Skip to main content

Manage Tenants

📌 What is a Tenant?​

In HelloMe, a Tenant is like a secure, separate workspace inside the platform.

A Tenant connects an Agent — and optionally an Agent Branch — to HelloMe’s system in a safe, organised way.

👉 Think of a tenant as a private room in a big office building (HelloMe). The Agent owns the room. Only they (and their branch staff) can open it using secure keys — the App ID and Secret Key — and do their work inside without mixing with other agents.

✅ Why Tenants Matter​

  • They keep each agent’s operations separate.
  • Make sure transactions, permissions, and settings do not overlap.
  • Allow secure API integrations using unique IDs and secret keys.
  • Help HelloMe work with multiple agents and branches in different countries — all safely isolated.

📌 What is the Manage Tenants Module?​

The Manage Tenants sub-module is where admins can:

  • Create, view, update, or remove tenants.
  • Link tenants to the correct Agent and Agent Branch.
  • Generate the secure Tenant App ID and Secret Key.
  • Control which parts of the system an agent or branch can access.

This keeps the platform tidy, secure, and well organised.

📋 How it Works​

1️⃣ Home Page:
Shows all tenants in a table with:

  • Tenant Name
  • Linked Agent
  • Linked Agent Branch
  • Tenant App ID (unique ID for secure API access)
  • Created By (who created it)
  • Actions: Edit, Delete, or open Settings.

2️⃣ Filters:
Filter tenants by:

  • Tenant Name
  • Agent
  • Agent Branch

3️⃣ Actions:

  • Edit: Update the tenant’s info, agent link, or branch link.
  • Delete: Remove a tenant if no longer needed.
  • Settings: Adjust tenant-specific integration settings.

➕ Adding a New Tenant​

Admins click Add Tenant to create a new tenant environment.

✅ Fields Needed:​

FieldWhat it Means
Tenant NameThe name of the tenant workspace.
AgentThe agent linked to this tenant.
Agent Branch(Optional) A specific branch linked to this tenant.
Tenant App IDUnique ID HelloMe’s system uses to identify the tenant.
Tenant Secret KeySecure key for safe system-to-system connection.

Once added, the tenant shows up in the list with its own App ID and Secret Key, ready for secure connections and transactions.

🔗 How It Connects to Other Modules​

Related ModuleHow It Works Together
Manage AgentsEvery tenant must be linked to an existing agent.
Manage BranchesTenants can be tied to specific branches to control which branch operates under which tenant.
APIs/IntegrationsThe App ID and Secret Key let agents and branches connect to HelloMe’s system safely.

✅ Practical Example​

Example:
Josh (Agent) has a branch called Gislason Group.
An admin creates a Tenant for Josh → Gislason Group, which gets its own App ID and Secret Key.
Now, transactions done by Gislason Group stay inside that tenant — clearly separated, securely connected, and easy to track.

📌 Key Takeaways​

  • Tenant = private, secure workspace for an agent (and branch).
  • Keeps operations separated, secure, and organised.
  • Uses App IDs and Secret Keys for safe connections.
  • Fully tied to Manage Agents, Manage Branches, and API Integrations.

In summary:
Tenants help HelloMe safely manage who can do what, by giving each agent or branch its own secure space inside the system — with clear rules, unique IDs, and strict separation.